Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding sphinx documentation #21

Merged
merged 11 commits into from
Aug 16, 2024
Merged

Adding sphinx documentation #21

merged 11 commits into from
Aug 16, 2024

Conversation

quic-amitraj
Copy link
Contributor

Updated and added docstring for all the APIs to support Sphinx docstring format.

@quic-amitraj quic-amitraj added the documentation Improvements or additions to documentation label May 23, 2024
@ochougul ochougul requested review from quic-mamta, quic-jhugo, ochougul and vbaddi and removed request for quic-jhugo May 23, 2024 13:52
@vbaddi
Copy link
Contributor

vbaddi commented May 30, 2024

Please rebase the branch to mainline. Also check if you can better __doc_string_ function defination for important Apis() to start with.

@quic-amitraj quic-amitraj requested a review from quic-jhugo June 5, 2024 09:30
@quic-amitraj
Copy link
Contributor Author

Please rebase the branch to mainline. Also check if you can better __doc_string_ function defination for important Apis() to start with.

Done.

@quic-amitraj quic-amitraj reopened this Jun 5, 2024
@quic-amitraj quic-amitraj force-pushed the Documentation_ready branch 2 times, most recently from 9f10d8b to 2c368ec Compare June 7, 2024 16:02
@quic-amitraj quic-amitraj requested a review from irajagop as a code owner June 7, 2024 16:02
@quic-amitraj quic-amitraj force-pushed the Documentation_ready branch from 2c368ec to 38a0e5b Compare June 7, 2024 18:05
@ochougul ochougul changed the title Documentation ready Adding sphinx documentation Jun 12, 2024
@ochougul ochougul force-pushed the Documentation_ready branch 2 times, most recently from ae4d701 to a76ed10 Compare June 12, 2024 09:08
@vbaddi
Copy link
Contributor

vbaddi commented Jun 17, 2024

@quic-amitraj , Can you rebase and build the docs and update to gh-phages branch again pls?

@quic-amitraj quic-amitraj force-pushed the Documentation_ready branch 2 times, most recently from 11033ee to e22c6cc Compare June 25, 2024 06:17
@quic-amitraj
Copy link
Contributor Author

@quic-amitraj , Can you rebase and build the docs and update to gh-phages branch again pls?

Done

quic-mamta
quic-mamta requested changes Jun 25, 2024
View reviewed changes
QEfficient/utils/run_utils.py Outdated Show resolved Hide resolved
QEfficient/generation/text_generation_inference.py Outdated Show resolved Hide resolved
QEfficient/cloud/execute.py Outdated Show resolved Hide resolved
QEfficient/cloud/infer.py Outdated Show resolved Hide resolved
QEfficient/exporter/export_utils.py Outdated Show resolved Hide resolved
QEfficient/utils/generate_inputs.py Outdated Show resolved Hide resolved
QEfficient/utils/generate_inputs.py Outdated Show resolved Hide resolved
QEfficient/utils/run_utils.py Outdated Show resolved Hide resolved
QEfficient/cloud/infer.py Outdated Show resolved Hide resolved
@quic-mamta
Copy link
Contributor

Can you please change the year in license of all files to 2024 only instead of 2023-2024.

quic-mamta
quic-mamta requested changes Jun 25, 2024
View reviewed changes
docs/conf.py Show resolved Hide resolved
@quic-amitraj quic-amitraj force-pushed the Documentation_ready branch from c2f47a1 to 33893d2 Compare June 25, 2024 12:22
quic-mamta
quic-mamta requested changes Jun 25, 2024
View reviewed changes
.github/CODEOWNERS Outdated Show resolved Hide resolved
QEfficient/cloud/execute.py Outdated Show resolved Hide resolved
QEfficient/cloud/infer.py Outdated Show resolved Hide resolved
QEfficient/compile/compile_helper.py Outdated Show resolved Hide resolved
QEfficient/exporter/export_hf_to_cloud_ai_100.py Outdated Show resolved Hide resolved
QEfficient/src/common.py Outdated Show resolved Hide resolved
QEfficient/transformers/models/falcon/modeling_falcon.py Outdated Show resolved Hide resolved
tests/test_loader.py Outdated Show resolved Hide resolved
notebooks/QEfficientMPT.ipynb Outdated Show resolved Hide resolved
docs/source/quick_start.md Show resolved Hide resolved
@quic-amitraj quic-amitraj requested a review from quic-mamta June 26, 2024 05:43
@quic-amitraj quic-amitraj force-pushed the Documentation_ready branch 3 times, most recently from 4f8e612 to fb50caf Compare July 19, 2024 06:34
@quic-amitraj quic-amitraj force-pushed the Documentation_ready branch 2 times, most recently from f39560f to 9cabfc8 Compare July 25, 2024 12:26
vbaddi
vbaddi reviewed Jul 29, 2024
View reviewed changes
pyproject.toml
@@ -36,6 +36,7 @@ dependencies = [

[project.optional-dependencies]
test = ["pytest","pytest-mock"]
docs = ["Sphinx==7.1.2","sphinx-rtd-theme==2.0.0","myst-parser==3.0.1"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@carlstreeter-quic @quic-jhugo , the packages will go as additional installation for docs only.
for someone to build docs, they can use pip install -e.[docs]. Please review.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@carlstreeter-quic @quic-jhugo ,we will be merging this PR early next week. (ETA August 13th 2024)
Please review and let us know if you have any queries. Thanks

ochougul
ochougul requested changes Aug 12, 2024
View reviewed changes
.github/quic-organization-repolinter.yml Outdated Show resolved Hide resolved
QEfficient/cloud/execute.py Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/source/Linux_installation.md Outdated Show resolved Hide resolved
docs/source/Linux_installation.md Outdated Show resolved Hide resolved
docs/source/cli_api.md Outdated Show resolved Hide resolved
docs/source/cli_api.md Outdated Show resolved Hide resolved
@quic-amitraj quic-amitraj force-pushed the Documentation_ready branch 2 times, most recently from c1aa76c to 70d2eb2 Compare August 13, 2024 14:04
quic-rishinr
quic-rishinr reviewed Aug 14, 2024
View reviewed changes
Copy link
Contributor

@quic-rishinr quic-rishinr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally the optional and required parameter fields are missing in most of the docstrings. Default values are also missing in some method docstrings

QEfficient/cloud/execute.py Outdated Show resolved Hide resolved
QEfficient/cloud/infer.py Outdated Show resolved Hide resolved
QEfficient/generation/cloud_infer.py Show resolved Hide resolved
QEfficient/transformers/models/modeling_auto.py Outdated Show resolved Hide resolved
QEfficient/transformers/transform.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
@vbaddi
Copy link
Contributor

vbaddi commented Aug 14, 2024 •
edited
Loading

@quic-rishinr @ochougul @irajagop @anujgupt-github, Can you please approve?, if everything looks good.

@ochougul
Spell check and minor fixes, beautification
95f7dbe 
Signed-off-by: Onkar Chougule <[email protected]>
@ochougul
ran formatter
b954c3a 
Signed-off-by: Onkar Chougule <[email protected]>
@quic-amitraj quic-amitraj merged commit 764b033 into quic:main Aug 16, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@quic-rishinr quic-rishinr quic-rishinr left review comments

@quic-akuruvil quic-akuruvil quic-akuruvil left review comments

@vbaddi vbaddi vbaddi left review comments

@ochougul ochougul ochougul approved these changes

@anujgupt-github anujgupt-github Awaiting requested review from anujgupt-github

@quic-jhugo quic-jhugo Awaiting requested review from quic-jhugo

@irajagop irajagop Awaiting requested review from irajagop

@quic-mamta quic-mamta Awaiting requested review from quic-mamta

Assignees

@quic-amitraj quic-amitraj

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@quic-amitraj @vbaddi @quic-mamta @ochougul @quic-akuruvil @quic-rishinr